home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d897.lha / EPP / Readme_First.doc < prev    next >
Text File  |  1993-06-26  |  4KB  |  80 lines
  1. ============================================================================
  2.  
  3.                          EPP V1.1 - E Preprocessor.
  4.              Copyright ©1993 Barry Wills.  All rights reserved.
  5.  
  6.  
  7. ============================================================================
  8.  
  9.  
  10. GETTING STARTED.
  11. ~~~~~~~~~~~~~~~
  12. The directories in this archive have the same structure as the original
  13. E V2.1b directory structure with the exception of the addition of the
  14. E/Pmodules directory and the E/Sources/Examples/EPP_Examples* directories.
  15.  
  16. See E/Docs/EPP.doc for copyright notice, a full description of what EPP is,
  17. and instructions on how to use EPP.
  18.  
  19. How to use the examples (CLI only):
  20.  
  21.     1.  Copy archive contents into the corresponding directories in which
  22.         you have installed E.
  23.     2.  CD to the E directory.
  24.     3.  Make the following DOS assignments:
  25.  
  26.         PATH bin add  ;If you have not already done so.
  27.         ASSIGN PMODULES: PModules
  28.  
  29.     4.  Example1:
  30.  
  31.         a.  CD to the directory E/Sources/Examples/EPP_Example1.  Type:
  32.  
  33.             EPP mod0 main  ;This produces the E source program main.e
  34.             EC main        ;This compiles the E source program main.e
  35.  
  36.         b.  The program main can now be run (although it will not do
  37.             anything.)  You may have noticed that E informs you of some
  38.             unused identifiers (well, okay, all the identifiers in this
  39.             example are unused.)  This example uses empty E structures in
  40.             modules nested 5 deep to demonstrate what EPP does.  Look at the
  41.             main module mod0.e and try to follow the module nesting.  Then
  42.             look at the file main.e to see what the final output looks like.
  43.  
  44.     5.  Example2:
  45.  
  46.         a.  CD to the directory E/Sources/Examples/EPP_Example2.  Type:
  47.  
  48.             EPP args main  ;This produces the E source program main.e
  49.             EC main        ;This compiles the E source program main.e
  50.  
  51.         b.  The program main can now be run.  This example uses some real
  52.             modules.  It accepts command-line arguments and displays the
  53.             values.  Run it without arguments first to find out the usage.
  54.             Then play with the arguments until you get a feel for what is
  55.             happening.  Then look at the original source code in files
  56.             args.e, E/PModules/commandLineArguments.e, E/Pmodules/skipWhite.e,
  57.             and E/skipNonWhite.e.  Finally, look at the source code in file
  58.             main.e to see how EPP brought the original files together.
  59.  
  60.         c.  Return to step a for each of the tests in the EPP_Example2
  61.             directory.
  62.  
  63. EPP is not very robust, but it is very simple to use.  The examples provided
  64. should be adequate to demostrate how to use EPP.  See the file
  65. EPP/Docs/EPP.doc for additional details and hints, copyright notice, and
  66. credits to others.
  67.  
  68. CAUTION:  This caution is repeated in EPP.doc.  In the instructions for
  69. compiling the examples the output file main.e is used.  You are not
  70. restricted to using this name as the final output name.  You are encouraged,
  71. however, to come up with a personal convention for naming the final output
  72. file.  That way you will not risk accidentally overwriting your original
  73. source.  One suggestion is to set up a separate directory to receive the
  74. final output file and compile it there:  a directory in RAM: or RAD: is
  75. ideal for this, and you could easily set up a script to make the process
  76. less unwieldy.
  77.  
  78.  
  79. ============================================================================
  80.